SureTax DRC API
Post Reset Form Instance
Overview
This endpoint is used to reset a specific form instance to its initial state. This action clears any modifications or updates made to the form instance, restoring it to its default configuration. The reset operation is typically used when the form needs to be reprocessed or when changes need to be undone.
OperationId: Post Reset Form Instance
Authorization Method(s): OAuth
Verb: POST
End Point: /api/Forms/ResetFormInstance
Example Request
The following is an json request for this operation.
{
"data": {
"id": "string",
"user": "string"
}
}
Many of the request headers listed below are designed to enhance traceability and provide supplementary information, allowing our team to efficiently identify and assess your API requests. Including these headers offers numerous benefits: they improve debugging and support by facilitating quick issue identification, enhance security through secure access and traceable actions, ensure accurate request tracking for thorough auditing, support better client management for compatibility, enable localization and personalization for tailored responses, and optimize business processes with clearer operation definitions. For implementation examples, please refer to our SDKs, which provide comprehensive guidance and practical integrations.
| Display String | Field Name | Field Type |
|---|---|---|
| X-request-id* | x-request-id | string |
Response codes in an API indicate the outcome of a request. They are three-digit numbers returned by the server to help the client understand if the request was successful, encountered an error, or needs further action. This operation has the following possible responses.
| code | description |
|---|---|
| 202 | The API responds with this code to indicate that the data was sent successfully. |
| 204 | 204 No Content If the form does not exist, the API will respond with a No Content status. Error Responses |
| 400 | Bad Request - The server could not process the request due to invalid input or missing required parameters. |
| 401 | 401 Unauthorized: The user's authentication is not valid. |
| 500 | Internal Server Error - An unexpected error occurred on the server while processing the request. |